<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Drops - Drops</title>
    <link rel="stylesheet" type="text/css" href="https://omaralbeik.github.io/Drops/all.css" media="all" />
</head>
<body>
    <header>
        <a href="https://omaralbeik.github.io/Drops/">
            <strong>
                Drops
            </strong>
            <span>Documentation</span>
        </a>
    </header>

    <!--
    <form class="search">
        <input type="search" placeholder="Search" />
    </form>
    -->

    <nav>
        <div class="wrapper">
            <h2>On This Page</h2>
            <ol><li><a href="#nested type aliases">Nested Type Aliases</a><ul><li class="typealias"><a href="#drops.drophandler">Drop​Handler</a></li></ul></li><li><a href="#initializers">Initializers</a><ul><li class="initializer"><a href="#drops.init(delaybetweendrops:)">init(delay​Between​Drops:​)</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="variable"><a href="#drops.willshowdrop">will​Show​Drop</a></li><li class="variable"><a href="#drops.didshowdrop">did​Show​Drop</a></li><li class="variable"><a href="#drops.willdismissdrop">will​Dismiss​Drop</a></li><li class="variable"><a href="#drops.diddismissdrop">did​Dismiss​Drop</a></li><li class="variable"><a href="#drops.willshowdrop">will​Show​Drop</a></li><li class="variable"><a href="#drops.didshowdrop">did​Show​Drop</a></li><li class="variable"><a href="#drops.willdismissdrop">will​Dismiss​Drop</a></li><li class="variable"><a href="#drops.diddismissdrop">did​Dismiss​Drop</a></li></ul></li><li><a href="#methods">Methods</a><ul><li class="function"><a href="#drops.show(_:)">show(_:​)</a></li><li class="function"><a href="#drops.hidecurrent()">hide​Current()</a></li><li class="function"><a href="#drops.hideall()">hide​All()</a></li><li class="function"><a href="#drops.show(_:)">show(_:​)</a></li><li class="function"><a href="#drops.hidecurrent()">hide​Current()</a></li><li class="function"><a href="#drops.hideall()">hide​All()</a></li></ul></li></ol>
        </div>
    </nav>

    <main>
        <article>
            <h1>
    <small>Class</small>
    <code class="name">Drops</code>
</h1>

<div class="declaration">
<pre class="highlight"><code><html><body><span class="attribute">@</span><span class="attribute">available</span>(<span class="variable">iOSApplicationExtension</span>, <span class="variable">unavailable</span>)
<span class="keyword">public</span> <span class="attribute">final</span> <span class="keyword">class</span> <span class="type">Drops</span>  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A shared class used to show and hide drops.</p>

</div>

    <section id="nested type aliases">
        <h2>Nested Type Aliases</h2>

        <div role="article" class="typealias" id="drops.drophandler">
    <h3>
        <code><a href="#drops.drophandler">Drop​Handler</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">typealias</span> <span class="variable">DropHandler</span> = (<a href="https://omaralbeik.github.io/Drops/Drop"><span class="type">Drop</span></a>) -&gt; <span class="type">Void</span></body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Handler.</p>

</div>
</div>
    </section>
    <section id="initializers">
        <h2>Initializers</h2>

        <div role="article" class="initializer" id="drops.init(delaybetweendrops:)">
    <h3>
        <code><a href="#drops.init(delaybetweendrops:)">init(delay​Between​Drops:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">init</span>(<span class="variable">delayBetweenDrops</span>: <span class="type">TimeInterval</span> = <span class="number literal">0.5</span>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Create a new instance with a custom delay between drops.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
  <thead hidden>
  <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
  </tr>
  </thead>
  <tbody>
    <tr>
    <th>delay​Between​Drops</th>
    <td><code class="type">Time​Interval</code></td>
    <td><p>Delay between drops in seconds. Defaults to <code>0.5 seconds</code>.</p>
</td>
</tr>
  </tbody>
</table>
</div>
    </section>
    <section id="properties">
        <h2>Properties</h2>

        <div role="article" class="variable" id="drops.willshowdrop">
    <h3>
        <code><a href="#drops.willshowdrop">will​Show​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">var</span> <span class="variable">willShowDrop</span>: <span class="type">DropHandler</span>?  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called before a drop is presented.</p>

</div>
</div>
<div role="article" class="variable" id="drops.didshowdrop">
    <h3>
        <code><a href="#drops.didshowdrop">did​Show​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">var</span> <span class="variable">didShowDrop</span>: <span class="type">DropHandler</span>?  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called after a drop is presented.</p>

</div>
</div>
<div role="article" class="variable" id="drops.willdismissdrop">
    <h3>
        <code><a href="#drops.willdismissdrop">will​Dismiss​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">var</span> <span class="variable">willDismissDrop</span>: <span class="type">DropHandler</span>?  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called before a drop is dismissed.</p>

</div>
</div>
<div role="article" class="variable" id="drops.diddismissdrop">
    <h3>
        <code><a href="#drops.diddismissdrop">did​Dismiss​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">var</span> <span class="variable">didDismissDrop</span>: <span class="type">DropHandler</span>?  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called after a drop is dismissed.</p>

</div>
</div>
<div role="article" class="variable" id="drops.willshowdrop">
    <h3>
        <code><a href="#drops.willshowdrop">will​Show​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">willShowDrop</span>: <span class="type">DropHandler</span>? </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called before a drop is presented.</p>

</div>
</div>
<div role="article" class="variable" id="drops.didshowdrop">
    <h3>
        <code><a href="#drops.didshowdrop">did​Show​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">didShowDrop</span>: <span class="type">DropHandler</span>? </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called after a drop is presented.</p>

</div>
</div>
<div role="article" class="variable" id="drops.willdismissdrop">
    <h3>
        <code><a href="#drops.willdismissdrop">will​Dismiss​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">willDismissDrop</span>: <span class="type">DropHandler</span>? </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called before a drop is dismissed.</p>

</div>
</div>
<div role="article" class="variable" id="drops.diddismissdrop">
    <h3>
        <code><a href="#drops.diddismissdrop">did​Dismiss​Drop</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">didDismissDrop</span>: <span class="type">DropHandler</span>? </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A handler to be called after a drop is dismissed.</p>

</div>
</div>
    </section>
    <section id="methods">
        <h2>Methods</h2>

        <div role="article" class="function" id="drops.show(_:)">
    <h3>
        <code><a href="#drops.show(_:)">show(_:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">func</span> <span class="function">show</span>(<span class="keyword">_</span> <span class="variable">drop</span>: <a href="https://omaralbeik.github.io/Drops/Drop"><span class="type">Drop</span></a>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Show a drop.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
  <thead hidden>
  <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
  </tr>
  </thead>
  <tbody>
    <tr>
    <th>drop</th>
    <td><code class="type">Drop</code></td>
    <td><p><code>Drop</code> to show.</p>
</td>
</tr>
  </tbody>
</table>
</div>
<div role="article" class="function" id="drops.hidecurrent()">
    <h3>
        <code><a href="#drops.hidecurrent()">hide​Current()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">func</span> <span class="function">hideCurrent</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Hide currently shown drop.</p>

</div>
</div>
<div role="article" class="function" id="drops.hideall()">
    <h3>
        <code><a href="#drops.hideall()">hide​All()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">func</span> <span class="function">hideAll</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Hide all drops.</p>

</div>
</div>
<div role="article" class="function" id="drops.show(_:)">
    <h3>
        <code><a href="#drops.show(_:)">show(_:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">show</span>(<span class="keyword">_</span> <span class="variable">drop</span>: <a href="https://omaralbeik.github.io/Drops/Drop"><span class="type">Drop</span></a>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Show a drop.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
  <thead hidden>
  <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
  </tr>
  </thead>
  <tbody>
    <tr>
    <th>drop</th>
    <td><code class="type">Drop</code></td>
    <td><p><code>Drop</code> to show.</p>
</td>
</tr>
  </tbody>
</table>
</div>
<div role="article" class="function" id="drops.hidecurrent()">
    <h3>
        <code><a href="#drops.hidecurrent()">hide​Current()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">hideCurrent</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Hide currently shown drop.</p>

</div>
</div>
<div role="article" class="function" id="drops.hideall()">
    <h3>
        <code><a href="#drops.hideall()">hide​All()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">hideAll</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Hide all drops.</p>

</div>
</div>
    </section>



        </article>
    </main>

    <footer>
        <p>
    Generated on <time datetime="2021-10-13T22:02:18+0200">October 13, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-rc.1</span>.
</p>
    </footer>
</body>
</html>
